home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / database / scscrpt1.zip / SCSCRIPT.TXT < prev    next >
Text File  |  1994-08-27  |  8KB  |  267 lines
  1. SC-Scripter 1.0 Copyright (C) 1994 SplitCycle Computing - All Rights Reserved
  2.  
  3. This file contains the following sections:
  4.  
  5.   * Overview
  6.   * System requirements
  7.   * Installation
  8.   * Command line parameters
  9.   * Command summary
  10.   * Support and questions
  11.  
  12. ========  O V E R V I E W  =================================================
  13.  
  14. SC-Scripter is a fast and easy SQL Server management assistant that
  15. can increase developer and database administrator productivity.  It
  16. will generate Transact-SQL scripts for entire databases or individual
  17. objects.  It's command line interface allows database definitions to
  18. be generated as part of your complete backup procedures.  This program
  19. can be a valuable tool in moving, restoring and examining databases.
  20.  
  21. SC-Scripter is distributed as Shareware.  This means that users are
  22. encouraged, subject to restrictions described in the License Agreement,
  23. to share copies of this program with friends, associates and bulletin
  24. boards.  Please remember that if you use this software you are required
  25. to pay the registration fee of $39 as described in files LICENSE.TXT
  26. and ORDER.TXT.
  27.  
  28. This program is produced by a member of the Association of Shareware
  29. Professionals (ASP).  ASP wants to make sure that the shareware
  30. principle works for you.  If you are unable to resolve a
  31. shareware-related problem with an ASP member by contacting the member
  32. directly, ASP may be able to help.  The ASP Ombudsman can help you
  33. resolve a dispute or problem with an ASP member, but does not provide
  34. technical support for members' products.  Please write to the ASP
  35. Ombudsman at 545 Grover Road, Muskegon, MI 49442 or send a CompuServe
  36. message via easyplex to ASP Ombudsman 70007,3536.
  37.               _______
  38.          ____|__     |               (R)
  39.       --|       |    |-------------------
  40.         |   ____|__  |  Association of
  41.         |  |       |_|  Shareware
  42.         |__|   o   |    Professionals
  43.       -----|   |   |---------------------
  44.            |___|___|    MEMBER
  45.  
  46.  
  47. ========  S Y S T E M   R E Q U I R E M E N T S  ===========================
  48.  
  49. -  Operating system should be one of the following
  50.  
  51.    * DOS 4.0 or above
  52.    * Microsoft Windows NT 3.1 or above
  53.    * IBM OS/2 2.1 or above
  54.  
  55. -  Network or local access to a Microsoft/Sybase SQL Server version
  56.    4.2 or above
  57.  
  58. -  Netlib from Microsoft or Sybase for DOS version 4.21 or above
  59.  
  60. -  SC-Scripter should work if ISQL (MS/Sybase utility) works.
  61.  
  62. ========  I N S T A L L A T I O N  =========================================
  63.  
  64. 1) If you already have installed a previous version of SC-Scripter, backup
  65.    and delete all files in your SCSCRIPT directory.  Otherwise create a
  66.    directory to hold the SC-Scripter related files.
  67.  
  68.    Example:
  69.  
  70.    C:\SCSCRIPT
  71.  
  72. 2) Copy all SC-Scripter related files to this directory.  At a minimum
  73.    you need SCSCRIPT.EXE
  74.  
  75. 3) Add "C:\SCSCRIPT" to your PATH in your AUTOEXEC.BAT file, if you
  76.    plan on using SC-Scripter frequently.
  77.  
  78. 4) Run SCSCRIPT.EXE (passing any necessary command line parameters).
  79.  
  80.    Example:
  81.  
  82.    SCSCRIPT -Usa -P               <--- assuming C:\SCSCRIPT is in
  83.                                        your PATH or that you are
  84.                                        currently in its directory.
  85.  
  86. ========  C O M M A N D   L I N E   P A R A M E T E R S  ===================
  87.  
  88. Syntax:
  89.  
  90.    SCScript [-U login id]
  91.         [-P password]
  92.         [-S server]
  93.         [-D database]
  94.         [-Q "command line query"]
  95.         [-I inputfile]
  96.         [-O outputfile]
  97.         [-? show syntax summary]
  98.  
  99.    Where
  100.  
  101.    -U login id
  102.       is the user login ID (case sensitive)
  103.  
  104.    -P password
  105.       is the user login's password (case sensitive).  SC-Scripter will
  106.       prompt for a password if -P is not passed (password not echoed).
  107.  
  108.    -S server
  109.       specifies the SQL Server that you wish to connect to (case sensitive)
  110.  
  111.    -D database
  112.       name of database that the connection should initially be made to
  113.  
  114.    -Q "command line query"
  115.       executes the specified command and then exist SC-Scripter
  116.  
  117.    -I inputfile
  118.       name of file containing a batch of SC-Scripter commands
  119.  
  120.    -O outputfile
  121.       name of file to be default destination for any created scripts
  122.  
  123.    -? show syntax summary
  124.       lists the available command line parameters
  125.  
  126. ========  C O M M A N D   S U M M A R Y  ===================================
  127.  
  128. The following commands are available:
  129.  
  130.    CREATE
  131.    DEPENDS
  132.    EXIT
  133.    HELP
  134.    LIST
  135.    QUIT
  136.    USE
  137.  
  138.  
  139. "CREATE"
  140.  
  141.         Generate a database object definition script file.
  142.  
  143.    syntax:
  144.  
  145.         CREATE objectname outputfile
  146.  
  147.         objectname - Name of object for which a script is to be
  148.                 generated or keyword "ALL".  Wild character "%"
  149.                 is allowed.
  150.         outputfile - Any valid filename to be used for script output.
  151.  
  152.    examples (assuming your in the pubs database):
  153.  
  154.         CREATE titles                   creates a script file for
  155.                                         object "titles".  The script
  156.                                         is written to the outputfile
  157.                                         specified on the command line
  158.                                         or to "titles.sql" as a
  159.                                         default.
  160.  
  161.         CREATE rep% miscrep.sql         creates a script file for
  162.                                         objects with names starting
  163.                                         with "rep".  All output is
  164.                                         written to file "miscrep.sql".
  165.  
  166.         CREATE ALL                      creates a script file for
  167.                                         all objects in the current
  168.                                         database.  The script is
  169.                                         written to the outputfile
  170.                                         specified on the command line
  171.                                         or to "pubs.sql".
  172.  
  173. "DEPENDS"
  174.  
  175.         Generate database object definitions for all objects that
  176.         are dependent on a specified table.
  177.  
  178.    syntax:
  179.  
  180.         DEPENDS tablename outputfile
  181.  
  182.         tablename - Name of user table in current database.
  183.         outputfile - Any valid filename to be used for script output.
  184.  
  185.    example:
  186.  
  187.         DEPENDS titles titles.dep       creates a script file for
  188.                                         all dependencies of table
  189.                                         "titles", output is written
  190.                                         to "titles.dep".
  191.  
  192. "EXIT"
  193.  
  194.         Exits the program.
  195.  
  196.    syntax:
  197.  
  198.         EXIT
  199.  
  200. "HELP"
  201.  
  202.         Displays list of available commands and short description.
  203.  
  204.    syntax:
  205.  
  206.         HELP
  207.  
  208. "LIST"
  209.  
  210.         List object names that match a specified search criteria.
  211.  
  212.    syntax:
  213.  
  214.         LIST objectname
  215.  
  216.         objectname - Character string used in matching object names
  217.                 in the current database.  Wild character "%" is allowed.
  218.  
  219.    example:
  220.  
  221.         LIST rep%                       list objects with names starting
  222.                                         with "rep".
  223.  
  224. "QUIT"
  225.  
  226.         Exits the program.
  227.  
  228.    syntax:    QUIT
  229.  
  230. "USE"
  231.  
  232.         Switches the database context to a specified database.
  233.  
  234.    syntax:
  235.  
  236.         USE database_name
  237.  
  238.         database_name - valid database name in the current server.
  239.  
  240.    example:
  241.  
  242.         USE pubs                        swith database context to "pubs".
  243.  
  244.  
  245. ========  S U P P O R T   A N D   Q U E S T I O N S  =======================
  246.  
  247. Technical support is available at no charge by sending electronic mail
  248. to 73501,1261 on CompuServe, or by sending US Mail to SplitCycle Computing,
  249. 13102 Rivergate Lane, Jacksonville, FL 32223.  Registered users have
  250. priority but I will try to answer all questions.
  251.  
  252. When reporting problems with SC-Scripter, please include the following
  253. information:
  254.  
  255. 1) Can the problem be recreated?  If so, how?
  256.  
  257. 2) What operating environment did this occur in?  Please specify version
  258.    of DOS, NT or OS/2.
  259.  
  260. 3) If an error message was displayed, please include the text of the message.
  261.  
  262. Suggestions for enhancements are welcome from all users.  A Windows
  263. version is being worked on and features specific to System 10 will be
  264. added shortly.
  265.  
  266. ========  E N D   O F   D O C U M E N T  ===================================
  267.